home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmClipboardCancelCopy.z / XmClipboardCancelCopy
Text File  |  1998-10-30  |  6KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy - A clipboard function that cancels a
  10.           copy to the clipboard
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/CutPaste.h>
  14.           int XmClipboardCancelCopy (_d_i_s_p_l_a_y, _w_i_n_d_o_w, _i_t_e_m__i_d)
  15.                   Display * _d_i_s_p_l_a_y;
  16.                   Window  _w_i_n_d_o_w;
  17.                   long    _i_t_e_m__i_d;
  18.           (vvvvooooiiiidddd)
  19.  
  20.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  21.           This page documents Motif 2.1.
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyycancels the copy to clipboard that is
  25.           in progress and frees up temporary storage.  When a copy is
  26.           to be performed, XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy allocates temporary
  27.           storage for the clipboard data. XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy copies the
  28.           appropriate data into the the temporary storage.
  29.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyycopies the data to the clipboard structure
  30.           and frees up the temporary storage structures.  If
  31.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy is called, the XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy
  32.           function does not have to be called. A call to
  33.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyyis valid only after a call to
  34.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy.
  35.  
  36.           _d_i_s_p_l_a_y   Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure that
  37.                     was returned in a previous call to XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or
  38.                     XXXXttttDDDDiiiissssppppllllaaaayyyy.
  39.  
  40.           _w_i_n_d_o_w    Specifies a widget's window ID that relates the
  41.                     application window to the clipboard.  The widget's
  42.                     window ID can be obtained through XXXXttttWWWWiiiinnnnddddoooowwww.  The
  43.                     same application instance should pass the same
  44.                     window ID to each of the clipboard functions that
  45.                     it calls.
  46.  
  47.           _i_t_e_m__i_d   Specifies the number assigned to this data item.
  48.                     This number was returned by a previous call to
  49.                     XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy.
  50.  
  51.      RRRREEEETTTTUUUURRRRNNNN
  52.           _X_m_C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
  53.                     The function was successful.
  54.  
  55.           _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
  56.                     The function failed because the clipboard was
  57.                     locked by another application. The application can
  58.                     continue to call the function again with the same
  59.                     parameters until the lock goes away. This gives
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCaaaannnncccceeeellllCCCCooooppppyyyy((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     the application the opportunity to ask if the user
  75.                     wants to keep trying or to give up on the
  76.                     operation.
  77.  
  78.           _X_m_C_l_i_p_b_o_a_r_d_F_a_i_l
  79.                     The function failed because XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy
  80.                     was not called or because the data item contains
  81.                     too many formats.
  82.  
  83.      RRRREEEELLLLAAAATTTTEEEEDDDD
  84.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddCCCCooooppppyyyy(3), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy(3), and
  85.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy(3).
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.